docs: consolidate all documentation into a single README - #30
Merged
Conversation
The README is now the only piece of documentation: - Fold docs/limitations.md into the README as a Limitations section, dropping the items already covered by Health, Widgets, and How it works. - Delete the vimdoc (doc/databricks-notebook.txt), the ADRs, and the maintainer smoke-test/probe documents; the full texts remain in git history. - Reword the smoke-kit README and molten_probe.lua so nothing links to the deleted files.
The smoke kit lost its purpose when the smoke-test runbook was deleted, and the demo notebook was only a Quickstart convenience — the header line in the README is enough to create one.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Survey of 10 popular Neovim plugin repos showed READMEs in the 170–620 line range acting as the primary manual; this takes that to its simplest form — one long README and nothing else:
doc/databricks-notebook.txt), both ADRs, the smoke-test procedure/runbook, and the Molten capability probe doc. All remain in git history if ever needed.tests/manual/molten_probe.luano longer link to deleted files. A repo-wide search confirms zero dangling references.Test plan
make checkpasses locally (stylua, ruff, mypy, 80 pytest, plenary specs).